Favicon

You are here: Home > API Reference > UEM > Device Audiences > Add new device audience

Add new device audience

Required Permission: mdm.global.deviceAudience.create

Add new device audience

POST
https://api.applivery.io/v1/organizations/{organizationId}/mdm/device-audiences 
curl -X POST "https://api.applivery.io/v1/organizations/{organizationId}/mdm/device-audiences" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "selectors": {
    "deviceGroups": [],
    "mdmUserGroups": [],
    "emmDeviceIds": [],
    "admDeviceIds": [],
    "winDeviceIds": [],
    "aosDeviceIds": [],
    "mdmUserIds": [],
    "serialNumbers": [],
    "smartAttributes": []
  },
  "segmentId": 0
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/device-audiences", {
  method: "POST",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "selectors": {
      "deviceGroups": [],
      "mdmUserGroups": [],
      "emmDeviceIds": [],
      "admDeviceIds": [],
      "winDeviceIds": [],
      "aosDeviceIds": [],
      "mdmUserIds": [],
      "serialNumbers": [],
      "smartAttributes": []
    },
    "segmentId": 0
  }),
});

const data = await response.json();
import requests

response = requests.post(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/device-audiences",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "name": "string",
      "description": "string",
      "selectors": {
        "deviceGroups": [],
        "mdmUserGroups": [],
        "emmDeviceIds": [],
        "admDeviceIds": [],
        "winDeviceIds": [],
        "aosDeviceIds": [],
        "mdmUserIds": [],
        "serialNumbers": [],
        "smartAttributes": []
      },
      "segmentId": 0
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json
name string required
≤ 256 characters
description string optional
≤ 256 characters
selectors object required
deviceGroups array [array] required
mdmUserGroups array [array] required
emmDeviceIds array [string] required
admDeviceIds array [string] required
winDeviceIds array [string] required
aosDeviceIds array [string] optional
mdmUserIds array [string] required
serialNumbers array [string] required
smartAttributes array [object] optional
id string required
Match pattern: ^[a-fA-F0-9]{24}$
operator any required
value any required
segmentId integer optional
≥ 0 · ≤ 9007199254740991
{
    "name": "string",
    "description": "string",
    "selectors": {
        "deviceGroups": [
            [
                "string"
            ]
        ],
        "mdmUserGroups": [
            [
                "string"
            ]
        ],
        "emmDeviceIds": [
            "string"
        ],
        "admDeviceIds": [
            "string"
        ],
        "winDeviceIds": [
            "string"
        ],
        "aosDeviceIds": [
            "string"
        ],
        "mdmUserIds": [
            "string"
        ],
        "serialNumbers": [
            "string"
        ],
        "smartAttributes": [
            {
                "id": "string",
                "operator": "equal",
                "value": "string"
            }
        ]
    },
    "segmentId": 0
}

Responses

200 Response application/json
status boolean required
data object required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
name string required
≤ 256 characters
description string optional
≤ 256 characters
createdAt string optional
updatedAt string optional
selectors object required
deviceGroups array [array] required
mdmUserGroups array [array] required
emmDeviceIds array [string] required
admDeviceIds array [string] required
winDeviceIds array [string] required
aosDeviceIds array [string] optional
mdmUserIds array [string] required
serialNumbers array [string] required
smartAttributes array [object] optional
segmentId integer optional
≥ 0 · ≤ 9007199254740991
{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "description": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "selectors": {
            "deviceGroups": [
                [
                    "string"
                ]
            ],
            "mdmUserGroups": [
                [
                    "string"
                ]
            ],
            "emmDeviceIds": [
                "string"
            ],
            "admDeviceIds": [
                "string"
            ],
            "winDeviceIds": [
                "string"
            ],
            "aosDeviceIds": [
                "string"
            ],
            "mdmUserIds": [
                "string"
            ],
            "serialNumbers": [
                "string"
            ],
            "smartAttributes": [
                {
                    "id": "string",
                    "operator": "equal",
                    "value": "string"
                }
            ]
        },
        "segmentId": 0
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5007
message string optional
File extension not allowed
{
    "status": false,
    "error": {
        "code": 5006,
        "message": "No File Found in request"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}